Docs: CLI #52
Merged
Docs: CLI #52
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sam-finch-tezos
added
documentation
johnyob
reviewed
Oct 16, 2023
johnyob
approved these changes
Oct 20, 2023
There was a problem hiding this comment.
In the interest of getting stuff merged, my comments can be addressed in a separate PR (especially given that CLI details will likely change within the next couple of weeks).
My only requirement before merging this would be adding this page to the config.mjs file
| $ >> exit | ||
| ``` | ||
|
|
||
| ::: tip |
There was a problem hiding this comment.
Tip feels unnecessary, given the tip at the start
|
|
||
| ::: tip | ||
|
|
||
| - `jstz help`: Displays a general help message or help information for specific subcommands. |
There was a problem hiding this comment.
I'd rephase this for the --help flag
Comment on lines
+126
to
+130
| - `--self-address (-s) <SELF_ADDRESS>`: Address used when deploying the contract. | ||
|
|
||
| - `--function-code (-f) <FUNCTION_CODE>`: The code for the function being deployed. | ||
|
|
||
| - `--balance (-b) <BALANCE>`: Specifies the initial balance for the function. |
| ### Example | ||
|
|
||
| ```bash | ||
| $ export counter=tz4CYGgcFtphw3AXS2Mx2CMmfj6voV5mPc9b # Address of the previously deployed contract examples/counter.js |
|
|
||
| ::: | ||
|
|
||
| # Logs |
There was a problem hiding this comment.
Would be best to move the logs section to the top
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
https://app.asana.com/0/1205170694555918/1205457666696805
Description
This PR an API reference and quick start for the URL runtime API
Manually testing the PR
npm run docs:dev